Skip to content

docs: readme and homepage improvements - #20

Merged
nitrajen merged 9 commits into
mainfrom
feat/pandas-backend
Apr 14, 2026
Merged

docs: readme and homepage improvements#20
nitrajen merged 9 commits into
mainfrom
feat/pandas-backend

Conversation

@nitrajen

Copy link
Copy Markdown
Owner

Summary

  • Tagline updated to include "Lightweight"
  • Opening paragraph: add Great Expectations mention with link, "such as...or" phrasing for type examples, consolidate into arm() + @Enforce + default subset behavior + subset=False note
  • Intro examples: subset=False on flag_high_value in all 3 backend tabs (docs homepage)
  • Intro examples: nested line_items field in raw_df for all 3 backends (README)
  • dataset() API docs: marked as internal utility with accurate tracked method lists
  • Install section moved before code examples in README
  • Fix broken pandas homepage example (label field missing from raw_df)
  • Remove schema history section from quickstart and README
  • Fix misplaced subset note in quickstart schema_of section

@codecov-commenter

Copy link
Copy Markdown

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@nitrajen
nitrajen merged commit 4b70417 into main Apr 14, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants